//=============================================================================
// System  : MatchKit
// File    : IMatchTracerExtensions.cs
// Author  : Fabio Bussu  (matchkit@fabiobussu.it)
// Updated : 04/16/2013
// Note    : Copyright 2013, Fabio Bussu, All rights reserved
//
// This code is published under the Microsoft Public License (Ms-PL). A copy
// of the license should be distributed with the code.  It can also be found
// at the project website: http://matchkit.codeplex.com. This notice, the
// author's name, and all copyright notices must remain intact in all
// applications, documentation, and source files.
//
// Version     Date     Who  Comments
// ============================================================================
// 1.0.0.0  04/16/2013   FB  First draft
//=============================================================================
using System;

namespace MatchKit
{
	/// <summary>
	/// Extends IMatchTracer inherited types with shortcut methods.
	/// </summary>
	/// <threadsafety static="true" />
	/// <conceptualLink target="0a06b2a9-5f58-409a-ba62-639cfd77bca7" />
	public static class IMatchTracerExtensions
	{
		/// <summary>
		/// Shortcut to write a <see cref="T:MatchKit.TraceEntry"/> with <see cref="F:MatchKit.TraceReason.Verbose"/> reason.
		/// </summary>
		/// <param name="tracer">The tracer instance. This value cannot be null.</param>
		/// <param name="context">The matching context. This value cannot be null.</param>
		/// <param name="pattern">The originating pattern.</param>
		/// <param name="message">Custom message. This value cannot be null.</param>
		/// <param name="args">Objects to format in the custom message.</param>
		public static void Verbose(
			#if EM
			this 
			#endif
			IMatchTracer tracer, MatchContext context, IPattern pattern, string message, params object[] args)
		{
			if (tracer == null)
				throw new ArgumentNullException("tracer", "tracer cannot be null");
			if (context == null)
				throw new ArgumentNullException("context", "context cannot be null");
			if (message == null)
				throw new ArgumentNullException("message", "message cannot be null");

			tracer.Write(new TraceEntry(
				TraceReason.Verbose,
				context,
				pattern,
				null,
				(args == null || args.Length == 0) ? message : string.Format(message, args)
			));
		}

		/// <summary>
		/// Shortcut to write a <see cref="T:MatchKit.TraceEntry"/> with <see cref="F:MatchKit.TraceReason.Warning"/> reason.
		/// </summary>
		/// <param name="tracer">The tracer instance. This value cannot be null.</param>
		/// <param name="context">The matching context. This value cannot be null.</param>
		/// <param name="pattern">The originating pattern.</param>
		/// <param name="message">Custom message. This value cannot be null.</param>
		/// <param name="args">Objects to format in the custom message.</param>
		public static void Warning(
			#if EM
			this 
			#endif
			IMatchTracer tracer, MatchContext context, IPattern pattern, string message, params object[] args)
		{
			if (tracer == null)
				throw new ArgumentNullException("tracer", "tracer cannot be null");
			if (context == null)
				throw new ArgumentNullException("context", "context cannot be null");
			if (message == null)
				throw new ArgumentNullException("message", "message cannot be null");

			tracer.Write(new TraceEntry(
				TraceReason.Warning,
				context,
				pattern,
				null,
				(args == null || args.Length == 0) ? message : string.Format(message, args)
			));
		}

		/// <summary>
		/// Shortcut to write a <see cref="T:MatchKit.TraceEntry"/> with <see cref="F:MatchKit.TraceReason.BeginMatch"/> reason.
		/// </summary>
		/// <param name="tracer">The tracer instance. This value cannot be null.</param>
		/// <param name="context">The matching context. This value cannot be null.</param>
		/// <param name="pattern">The originating pattern.</param>
		public static void BeginMatch(
			#if EM
			this 
			#endif
			IMatchTracer tracer, MatchContext context, IPattern pattern)
		{
			if (tracer == null)
				throw new ArgumentNullException("tracer", "tracer cannot be null");
			if (context == null)
				throw new ArgumentNullException("context", "context cannot be null");

			tracer.Write(new TraceEntry(
				TraceReason.BeginMatch,
				context,
				pattern,
				null,
				null
			));
		}

		/// <summary>
		/// Shortcut to write a <see cref="T:MatchKit.TraceEntry"/> with <see cref="F:MatchKit.TraceReason.Verbose"/> reason.
		/// </summary>
		/// <param name="tracer">The tracer instance. This value cannot be null.</param>
		/// <param name="context">The matching context. This value cannot be null.</param>
		/// <param name="pattern">The originating pattern.</param>
		/// <param name="message">Custom message. This value cannot be null.</param>
		/// <param name="args">Objects to format in the custom message.</param>
		public static void BeginMatch(
			#if EM
			this 
			#endif
			IMatchTracer tracer, MatchContext context, IPattern pattern, string message, params object[] args)
		{
			if (tracer == null)
				throw new ArgumentNullException("tracer", "tracer cannot be null");
			if (context == null)
				throw new ArgumentNullException("context", "context cannot be null");
			if (message == null)
				throw new ArgumentNullException("message", "message cannot be null");

			tracer.Write(new TraceEntry(
				TraceReason.BeginMatch,
				context,
				pattern,
				null,
				(args == null || args.Length == 0) ? message : string.Format(message, args)
			));
		}

		/// <summary>
		/// Shortcut to write a <see cref="T:MatchKit.TraceEntry"/> with <see cref="F:MatchKit.TraceReason.MatchFailed"/> or 
		/// <see cref="F:MatchKit.TraceReason.MatchSuccess"/> reason.
		/// </summary>
		/// <param name="tracer">The tracer instance. This value cannot be null.</param>
		/// <param name="context">The matching context. This value cannot be null.</param>
		/// <param name="match">The resulted match. This value cannot be null.</param>
		public static void MatchComplete(
			#if EM
			this 
			#endif
			IMatchTracer tracer, MatchContext context, Match match)
		{
			if (tracer == null)
				throw new ArgumentNullException("tracer", "tracer cannot be null");
			if (context == null)
				throw new ArgumentNullException("context", "context cannot be null");
			if (match == null)
				throw new ArgumentNullException("match", "match cannot be null");

			if (match.Success)
				MatchSuccess(tracer, context, match);
			else
				MatchFailed(tracer, context, match);
		}

		/// <summary>
		/// Shortcut to write a <see cref="T:MatchKit.TraceEntry"/> with <see cref="F:MatchKit.TraceReason.MatchFailed"/> or 
		/// <see cref="F:MatchKit.TraceReason.MatchSuccess"/> reason.
		/// </summary>
		/// <param name="tracer">The tracer instance. This value cannot be null.</param>
		/// <param name="context">The matching context. This value cannot be null.</param>
		/// <param name="match">The resulted match. This value cannot be null.</param>
		/// <param name="message">Custom message. This value cannot be null.</param>
		/// <param name="args">Objects to format in the custom message.</param>
		public static void MatchComplete(
			#if EM
			this 
			#endif
			IMatchTracer tracer, MatchContext context, Match match, string message, params object[] args)
		{
			if (match == null)
				throw new ArgumentNullException("match", "match cannot be null");
			if (match.Success)
				MatchSuccess(tracer, context, match, message, args);
			else
				MatchFailed(tracer, context, match, message, args);
		}

		/// <summary>
		/// Shortcut to write a <see cref="T:MatchKit.TraceEntry"/> with <see cref="F:MatchKit.TraceReason.MatchFailed"/> reason.
		/// </summary>
		/// <param name="tracer">The tracer instance. This value cannot be null.</param>
		/// <param name="context">The matching context. This value cannot be null.</param>
		/// <param name="match">The resulted match. This value cannot be null.</param>
		public static void MatchFailed(
			#if EM
			this 
			#endif
			IMatchTracer tracer, MatchContext context, Match match)
		{
			if (tracer == null)
				throw new ArgumentNullException("tracer", "tracer cannot be null");
			if (context == null)
				throw new ArgumentNullException("context", "context cannot be null");
			if (match == null)
				throw new ArgumentNullException("match", "match cannot be null");

			tracer.Write(new TraceEntry(
				TraceReason.MatchFailed,
				context,
				match.Pattern,
				match,
				null
			));
		}

		/// <summary>
		/// Shortcut to write a <see cref="T:MatchKit.TraceEntry"/> with <see cref="F:MatchKit.TraceReason.MatchFailed"/> reason.
		/// </summary>
		/// <param name="tracer">The tracer instance. This value cannot be null.</param>
		/// <param name="context">The matching context. This value cannot be null.</param>
		/// <param name="match">The resulted match. This value cannot be null.</param>
		/// <param name="message">Custom message. This value cannot be null.</param>
		/// <param name="args">Objects to format in the custom message.</param>
		public static void MatchFailed(
			#if EM
			this 
			#endif
			IMatchTracer tracer, MatchContext context, Match match, string message, params object[] args)
		{
			if (tracer == null)
				throw new ArgumentNullException("tracer", "tracer cannot be null");
			if (context == null)
				throw new ArgumentNullException("context", "context cannot be null");
			if (match == null)
				throw new ArgumentNullException("match", "match cannot be null");
			if (message == null)
				throw new ArgumentNullException("message", "message cannot be null");

			tracer.Write(new TraceEntry(
				TraceReason.MatchFailed,
				context,
				match.Pattern,
				match,
				(args == null || args.Length == 0) ? message : string.Format(message, args)
			));
		}

		/// <summary>
		/// Shortcut to write a <see cref="T:MatchKit.TraceEntry"/> with <see cref="F:MatchKit.TraceReason.MatchSuccess"/> reason.
		/// </summary>
		/// <param name="tracer">The tracer instance. This value cannot be null.</param>
		/// <param name="context">The matching context. This value cannot be null.</param>
		/// <param name="match">The resulted match. This value cannot be null.</param>
		public static void MatchSuccess(
			#if EM
			this 
			#endif
			IMatchTracer tracer, MatchContext context, Match match)
		{
			if (tracer == null)
				throw new ArgumentNullException("tracer", "tracer cannot be null");
			if (context == null)
				throw new ArgumentNullException("context", "context cannot be null");
			if (match == null)
				throw new ArgumentNullException("match", "message cannot be null");

			tracer.Write(new TraceEntry(
				TraceReason.MatchSuccess,
				context,
				match.Pattern,
				match,
				null
			));
		}

		/// <summary>
		/// Shortcut to write a <see cref="T:MatchKit.TraceEntry"/> with <see cref="F:MatchKit.TraceReason.MatchSuccess"/> reason.
		/// </summary>
		/// <param name="tracer">The tracer instance. This value cannot be null.</param>
		/// <param name="context">The matching context. This value cannot be null.</param>
		/// <param name="match">The resulted match. This value cannot be null.</param>
		/// <param name="message">Custom message. This value cannot be null.</param>
		/// <param name="args">Objects to format in the custom message.</param>
		public static void MatchSuccess(
			#if EM
			this 
			#endif
			IMatchTracer tracer, MatchContext context, Match match, string message, params object[] args)
		{
			if (tracer == null)
				throw new ArgumentNullException("tracer", "tracer cannot be null");
			if (context == null)
				throw new ArgumentNullException("context", "context cannot be null");
			if (match == null)
				throw new ArgumentNullException("match", "message cannot be null");
			if (message == null)
				throw new ArgumentNullException("message", "message cannot be null");

			tracer.Write(new TraceEntry(
				TraceReason.MatchSuccess,
				context,
				match.Pattern,
				match,
				(args == null || args.Length == 0) ? message : string.Format(message, args)
			));
		}
	}
}
